/*
 * Copyright 2007 Dan Hodge
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package net.datajanitor.baja.data;

/**
 * Represents the path information for a file on the box server.
 */
public interface BoxFile {
    /**
     * @return true If this is the root directory, false if not
     */
    public boolean isRoot();
    
    /**
     * Gets the parent directory
     * @return The parent directory of this file, or null if this is the root directory
     */
    public BoxFile getParent();
    
    /**
     * Gets the name of this file
     * @return The file name
     */
    public String getName();
    
    /**
     * Gets the full path for this file
     * @return The full path
     */
    public String getPath();
}
